Pagamento de Boleto Bancário

Esta funcionalidade permite que os clientes paguem boletos e impostos (água, luz, gás, telefone, etc. Veja a lista de convênios disponíveis).

Processo de pagamento de boleto

O processo de pagamento consiste nos seguintes passos:

Consultar as informações da conta
Com a resposta, o sistema do cliente deve validar algumas informações antes do pagamento.
Validar o status de pagamento da conta. O pagamento só será efetuado para contas com status igual a PENDING_PAYMENT.
Validar a flag isAllowPartialPayment, onde esta indica se o pagamento parcial é permitido. Se esta flag for true, verificar a faixa de valores de acordo com as informações presentes no objeto de cálculo de pagamento paymentCalculation.
Após as verificações necessárias, realizar o processo de pagamento.

Verificando informações de pagamento

Requisição

URL
cURL

GET 'https://apisandbox.delbank.com.br/baas/api/v1/bill-payments/43594939800000003250001112000000200000311672'

curl -X 'GET' \
  'https://apisandbox.delbank.com.br/baas/api/v1/bill-payments/43594939800000003250001112000000200000311672' \
  -H 'x-delbank-api-key: {{apiKey}}'

Headers

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API

Parâmetros Path:

Informe o código de barras ou a linha digitável.

Example: https://apisandbox.delbank.com.br/baas/api/v1/bill-payments/${PAYMENT_IDENTIFIER}

Resposta

{
    "identifierNumber": "3023063000107986253",
    "type": "BANKSLIP",
    "status": "PAYMENT_DEADLINE_EXCEEDED",
    "amount": 3.25,
    "dueDate": "2023-07-01T19:30:00",
    "barCode": "43594939800000003250001112000000200000311672",
    "digitableLine": "43590001161200000020300003116720493980000000325",
    "isAllowPartialPayment": false,
    "paymentCalculation": {
        "rebateAmount": 0.0,
        "interesetAmount": 2.23,
        "fineAmount": 3.25,
        "discountAmount": 0.0,
        "chargedAmount": 8.73,
        "minimumPaymentAmount": 8.73,
        "maximumPaymentAmount": 8.73
    },
    "payer": {
        "document": "1234567123",
        "name": "JAMES XPTO",
        "type": "NATURAL"
    },
    "overduePaymentInterest": {
        "date": "2023-07-02",
        "amount": 23.53,
        "type": "PERCENTAGE"
    },
    "overduePaymentFine": {
        "date": "2023-07-02",
        "amount": 3.25,
        "type": "FIXED"
    },
    "discounts": [],
    "beneficiary": {
        "document": "11468192000181",
        "name": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "fantasyName": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "type": "LEGAL"
    },
    "issuer": {
        "ispb": "38224857",
        "name": "DELCRED SCD S.A.",
        "nameFantasy": "DELBANK"
    }
}

Name	Type	Description
type	`enum`	Tipo de pagamento. Domínios: - `BANKSLIP` - Boleto Bancário - `TAXES` - Taxa ou impostos
status	`enum`	Status do pagamento. Domínios: - `PAID` - Pago - `PENDING_PAYMENT` - Pagamento pendente - `BLOCKED_PAYMENT` - Pagamento bloqueado - `PAYMENT_DEADLINE_EXCEEDED` - Pagamento passou do vencimento
amount	`number`	Valor pago
dueDate	`datetime`	Data de expiração, incluindo a hora.
barCode	`string`	Código de barras
digitableLine	`string`	Linha digitalizável
isAllowPartialPayment	`boolean`	Flag que permite pagamento parcial
payer	`object`	Informações do pagador
payer.document	`string`	Documento do pagador
payer.name	`string`	Nome do pagador
payer.type	`enum`	Tipo de documento do pagador. Domínios: - `NATURAL` - Pessoa Física - `LEGAL` - Pessoa Jurídica
issuer	`object`	Emissão de informações bancárias
issuer.ispb	`string`	ISPB do Banco emissor
issuer.name	`string`	Nome do Banco emissor
issuer.nameFantasy	`string`	Nome Fantasia do Banco emissor
beneficiary	`object`	Informações do beneficiário
beneficiary.name	`string`	Nome do beneficiário
beneficiary.document	`string`	Documento do beneficiário
overduePaymentInterest	`object`	Parâmetros de juros
overduePaymentInterest.date	`date`	Data de referência para aplicação de juros
overduePaymentInterest.amount	`number`	Tipo de juros da cobrança
overduePaymentFine.type	`enum`	Tipo de juros da cobrança. Domains: - `PERCENTAGE` - Porcentagem - `FIXED` - Valor absoluto
overduePaymentFine	`object`	Objeto de parâmetros para multa
overduePaymentFine.date	`date`	Data de referência para aplicação da multa
overduePaymentFine.amount	`number`	Valor de referência na aplicação da multa
overduePaymentFine.type	`enum`	Tipos de multa: - `PERCENTAGE` - Porcentagem - `FIXED` - Valor absoluto
paymentCalculation	`object`	Informações auxiliares para uso durante o cálculo do pagamento
paymentCalculation.rebateAmount	`number`	Valor do desconto (boleto bancário)
paymentCalculation.interestAmount	`number`	Valor total dos juros
paymentCalculation.fineAmount	`number`	Valor total da multa
paymentCalculation.discountAmount	`number`	Valor total do desconto
paymentCalculation.chargedAmount	`number`	Valor total a ser cobrado
paymentCalculation.minimumPaymentAmount	`number`	Valor mínimo de pagamento
paymentCalculation.maximumPaymentAmount	`number`	Valor máximo de pagamento

Efetuando o pagamento

Requisição

URL
cURL

POST 'https://apisandbox.delbank.com.br/baas/api/v1/bill-payments'

curl --request POST \
     --url https://apisandbox.delbank.com.br/baas/api/v1/bill-payments \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "amount": 691.71,
    "barCode": "43596938200000691710001112000000200000309361"
}
'

Headers

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API
IdempotencyKey	Obrigatório. Chave de idempotência da solicitação. Forneça um GUID, sendo um novo para cada solicitação.

Corpo da Requisição

Nome	Tipo	Descrição
amount	`number`	Obrigatório. Valor do pagamento
barCode	`string`	Código de barras de pagamento de contas Use esta informação se você não fornecer a `digitableLine`
digitableLine	`string`	Linha de pagamento de fatura digitável Use esta informação se você não fornecer o `barCode`

Resposta

O código de status 200 garante que a transação foi bem-sucedida.

Sendo bem-sucedida, o retorno trará o seguinte campo no formato Json:

{
    "id": "1694017754",
    "identifierNumber": "3023061406106689529",
    "barCode": "43596938200000691710001112000000200000309361",
    "digitableLine": "43590001161200000020300003093614693820000069171",
    "status": "PAID",
    "dueDate": "2023-06-15T19:30:00",
    "createdAt": "2023-09-06T16:29:14.950Z",
    "originalAmount": 691.71,
    "paidAmount": 691.71,
    "paymentCalculation": {
        "rebateAmount": 0.0,
        "interesetAmount": 862.92,
        "fineAmount": 100.0,
        "discountAmount": 0.0,
        "chargedAmount": 1654.63,
        "minimumPaymentAmount": 1654.63,
        "maximumPaymentAmount": 1654.63
    },
    "beneficiary": {
        "document": "11468192000181",
        "name": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "fantasyName": "DEL CRED NP FUNDO DE INVESTIMENTO",
        "type": "LEGAL"
    },
    "issuer": {
        "ispb": "38224857",
        "name": "DELCRED SCD S.A.",
        "nameFantasy": "DELBANK"
    }
}

Processo de pagamento de boleto​

Verificando informações de pagamento​

Requisição​

Headers​

Parâmetros Path:​

Resposta​

Efetuando o pagamento

Requisição​

Headers​

Corpo da Requisição​

Resposta​

Processo de pagamento de boleto

Verificando informações de pagamento

Requisição

Headers

Parâmetros Path:

Resposta

Requisição

Headers

Corpo da Requisição

Resposta